Fix two broken links in the docs. #1854
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(One was enountered manually, the other found via Sphinx's builtin linkcheck builder, which also confirms there aren't really any others.)
I often suggest using Sphinx's
default_role
setting to make writing docs quite a bit less noisy in a fairly uncontroversial way. A toxenv / docs setup in CI also seems like a decent idea. As is, there is a small part of the docs which isn't being rendered because it contains errors (in the output below it's the oneCRITICAL
), and there are some other interlinks which are broken. Essentially, IMHO, running Sphinx without-n -T -W
is a recipe for brokenness unfortunately. This is what one sees when doing so, even after this PR:I'm trying to actually use connexion for the first time, but if the above sounds reasonable to y'all maintainers I can try to come back to it and send a PR later.